/*
 * Copyright (C) 2024 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.android.tools.idea.logcat

import com.intellij.execution.filters.Filter
import com.intellij.openapi.editor.ex.EditorEx
import com.intellij.openapi.extensions.ExtensionPointName

/**
 * Provides a [Filter] that is applicable only to the logcat console.
 *
 * Unlike regular Filter's that operate on lines, logcat specific filters get access to the editor
 * containing the logcat buffer and can hence operate on structured logcat messages by retrieving
 * them from the editor.
 */
interface LogcatConsoleFilterProvider {
  fun create(editor: EditorEx): Filter

  companion object {
    internal val EP_NAME: ExtensionPointName<LogcatConsoleFilterProvider> =
      ExtensionPointName.create("com.android.tools.idea.logcat.consoleFilterProvider")
  }
}
